home *** CD-ROM | disk | FTP | other *** search
/ Ian & Stuart's Australian Mac 1993 September / September 93.iso / Archives / Utilities / System / FKey / FKeys / Locare1.8 / Locare 1.8 SW Doc < prev   
Text File  |  1987-06-18  |  10KB  |  229 lines
  1. Locare 1.8d1 Documentation
  2.  
  3. Locare was (and will always be) written by Raymond Lau.
  4. Copyright 1987, Raymond Lau.
  5. Portions copyright 1986, THINK Technologies, Inc.
  6.  
  7. June 18,1987
  8.  
  9.  
  10. Locare is a lost file finder FKEY patterned after PCPC's Eureka!
  11.  
  12.  
  13. IMPORTANT: USE ONLY WITH A HFS EQUIPPED SYSTEM.  IF YOU RUN IT ON A MFS
  14. SYSTEM (128K OR 512K W/O HD 20 FILE), IT *WILL* RESULT IN A SYSTEM ERROR.
  15. Be forewarned!
  16.  
  17.  
  18. NOTE: ANY FEATURE DOCUMENTED IS IMPLEMENTED IN THE PRIVATE RELEASE TO
  19. REGISTERED OWNERS.  MANY OF THESE FEATURES HAVE BEEN DISABLED IN THE
  20. DEMO RELEASE.  (for ex: type, date, creator filtration, deletion of files,
  21. getinfo comments, etc.)
  22.  
  23.  
  24. Installation:
  25.  
  26.  
  27. To install Locare, use FKEY Mgr, FKEY Installer or a resource editor.  I
  28. suggest the use of FKEY Mgr since it's as easy to use as Apple's Font/DA
  29. Mover.
  30. Locare comes set as FKEY number 8, however, it may be renumbered at will.
  31.  
  32.  
  33. Operation:
  34.  
  35. Type in a part of the name of the file you are searching for.
  36. Locare will search for all files containing what you typed
  37. and display them one by one with each click of the "Find!" button.  If
  38. you wish to limit the match to the start or end of the file name, click on
  39. the appropriate button.  Locare will default to the first mounted volume,
  40. which is usually the hard disk you booted up with (assuming you are using a
  41. hd).  If you wish to search on a separate volume, click on the drive
  42. button.  Some info (and an icon) about the volume is displayed.  Icons are
  43. not shown for offline volumes, but info such as name, used, free, are shown.
  44. You ARE allowed to search an ejected ("Offline") volume, but you
  45. will be prompted to insert that disk.  You may cancel such a request by
  46. typing command-period.
  47.  
  48. The "at beginning/anywhere/at end" radio boxes tell which part of the
  49. filename Locare will compare against the search string.
  50.  
  51. The find only files modified before/after/anytime should be self
  52. explanatory.  Enter the month/day/year into the boxes.  WARNING: Invalid dates
  53. will be interpreted in strange manners.  The date Locare sees will always
  54. be displayed once Find (or return) is selected.
  55.  
  56. The radio buttons marked "all types/appls/other/type" are used to filter files
  57. by file type.  All includes everything.  Appls include only applications.
  58. Other includes documents, various support and system files, etc.  (non-APPL)
  59. Type allows you to specify which single type you want Locare to see.
  60. Some common file types include:
  61.  
  62.     TEXT - text only file.
  63.     WORD - MacWrite file.
  64.     PNTG - MacPaint (also FullPaint) file.
  65.     FKEY - FKEYs
  66.     DFIL - Font/DA Mover DA File
  67.     SPTG - SuperPaint file.
  68.     XLBN - Excel file.
  69.     PICT - MacDraw PICT file.
  70.     nX^d - WriteNow file.
  71.  
  72. File types are case sensitive and must be either 4 characters long or
  73. empty.  If you enter more than 4 chars, Locare will cut off all chars after
  74. the first 4.  If you enter less, Locare will assume you meant an empty
  75. file type.  Spaces are valid characters.
  76.  
  77. The radio buttons marked any/creator are used to filter files by creator.
  78. If any is selected, such filtering is deactivated.  If creator is selected,
  79. only files matching the creator entered in the box below it will be
  80. displayed.  Rules for file types also apply to file creators.  Some
  81. common creators are:
  82.  
  83.     MACA - MacWrite
  84.     nX^n - WriteNow
  85.     XCEL - Excel
  86.     PANT - FullPaint
  87.     CRDW - Cricket Draw
  88.     MDRW - MacDraw
  89.     SPNT - SuperPaint
  90.     ALD2 - PageMaker 2.0
  91.     MRSN - Ready,Set,Go! 3
  92.  
  93. (Note: Many applications are capable of opening files created by other
  94. applications...ex: FullPaint can open MacPaint files.  Setting the
  95. creator filtering to a certain creator won't show files created by
  96. other applications.  In our ex, this means setting creator to PANT won't
  97. show files created by MacPaint.)
  98.     
  99.  
  100. A found file may be deleted.  WARNING: The delete is done at the click of
  101. the mouse.  No warning dialog...yet.
  102.  
  103. A found file's GetInfo comments will also be displayed.  It may take
  104. a while for Locare to find these comments on large volumes bec. it has
  105. to find and open the Desktop file.  If your cache is activated (via
  106. Control Panel), the search will be greatly shorten the next time a file
  107. is found on the same volume in the same application.
  108.  
  109. When Locare is closed, it will set the folder in the SFGetFile
  110. ("minifinder") box to the one in which the last file was found.  If you
  111. launched Locare on top of such a box, the folder won't be changed by
  112. Locare.  If you hold the shift key down when you close Locare
  113. (shift-cmd-period or shift-click close box), Locare won't change the
  114. SFGetFile folder.  When closed, Locare will also saved the settings used
  115. in this search (string,location,modified time, etc).  The next time Locare
  116. is opened, it'll read these settings.  These settings are stored in a
  117. file called "Locare Defaults" in the current system folder.  Apple has
  118. documented a potential bug with the way Locare uses BootDrive to find
  119. the System folder.  I haven't been able to reproduce this bug, so I didn't
  120. bother implementing Apple's workaround (which would increase Locare's size)
  121. If you find that Locare startes creating the Locare Defaults in any folder
  122. but the System folder, tell me.
  123.  
  124.  
  125. Keyboard Shortcuts:
  126.  
  127. Return key is the same as clicking on the Find! button.
  128. Command-tab or Shift-tab is the same as clicking on the Drive button.
  129. Tab moves from one edit box to the next.
  130. Command-period is the same as closing Locare except when you are prompted
  131.     for a disk, in which case, it will abort the search then.
  132.  
  133.  
  134. Known bugs:
  135.  
  136. Locare crashes if opened from the keyboard in the Switcher 5.1 environment.
  137. I don't know about other versions.  From what I can see, this problem is
  138. caused by Switcher's modification of the GetNextEvent trap.  I do not see
  139. a feasible way to eliminate it.  However, there is a SIMPLE workaround.  If
  140. Locare is opened through the Pop-Keys menu (part of C. Weber's FKEY Mgr.
  141. package), it will NOT crash.  Opening through pop-keys simulates
  142. standard way FKEYs are opened, so it works.  Opening by pressing shift-cmd-
  143. (whatever # u gave Locare) in Switcher causes various Switcher related tasks
  144. to be performed which causes Locare to crash when closed.  (Maybe 5.2 will
  145. be more compatible...or maybe "Juggler" will make it out...) 
  146.  
  147. An alternative workaround is to use Switcher 5.0.  The only difference that
  148. I can see is that 5.0 doesn't support scratchpad applications.  (I still have
  149. yet to find out what they are!)
  150.  
  151.  
  152.  
  153. Planned additions:
  154.  
  155. Option to rename files found.
  156. Possibly a list of files found.
  157. A search all mounted volumes.
  158. A search all online volumes.
  159. Option to mod GetInfo comments.
  160. Option to not read GetInfo comments...to speed up quick searches.
  161. Option to abort search.
  162. Better error checking.
  163.  
  164. I do not plan to add wildcard capabilities...personally I don't see any need
  165. for it.  If you differ with me on this, tell me...
  166.  
  167. Your comments on these ideas and your suggestions are welcomed (as are
  168. bug reports...after all, nothing is bug free.)
  169.  
  170.  
  171. Distribution:
  172.  
  173. This version of Locare (1.8 Shareware Demo) may be distributed freely as
  174. long as it's distributed w/o financial compensation and not as an
  175. incentive to buy another product.
  176.  
  177. Usage/Shareware:
  178.  
  179. You may try this version of Locare out for a period of two weeks.  If you
  180. decide that you like it or find it useful, send the author (that's me I
  181. hope!) $10 with a disk and a self addressed stamped envelop for the latest
  182. version.  (It'll get back to you before the trial version expires if enough
  183. time for mail delivery exists.  I just MAY detain sending it until that
  184. last addition/fix is in though).  Or send $15 and I'll you a s/s disk.
  185. Any customer of any of my previous products is entitled to a $3 discount.
  186.  
  187. Your first (and possibly second depending on Locare's maturity) update is
  188. on me.  All I ask is that you return my disk.
  189. Other updates are available for free if you send a disk and sase.  Or send
  190. $5...  All major updates will be accompanied by a public release of an
  191. older version.  I will mainly depend on this as the means of spreading the
  192. word.  However, if I find that you've missed a major update (or a few
  193. minor updates), I WILL send you a reminder letter.
  194.  
  195. Remember, I need you to make this method of distribution work.  As long as
  196. there's some response, I will support the product whenever I can see a
  197. possible improvement or whenever a reasonable one is suggested.  If there
  198. is no response, I'd assume no one finds such a product useful.  If you find
  199. it useful, register.  If not, don't.  Don't wait for someone else to do it.
  200. (That wait will last until eternity.)
  201.  
  202. Currently the private version displays info about files as they are found.
  203.  
  204.  
  205. Raymond Lau
  206. 100-04 70 Ave.
  207. Forest Hills, NY 11375
  208.  
  209. (Note: DON'T SEND CASH THROUGH THE MAIL!)
  210.  
  211.  
  212. GEnie:RAYLAU
  213. CIS:76174,2617
  214. Delphi: RAYMONDLAU
  215.  
  216. Some thoughts which are totally unneeded for anything but your edification...
  217.  
  218. Some potential "bugs" which cannot be avoided...  Due to the current precision
  219. of the File Manager and B-D package, volume sizes over 2Gigabytes (2048Mb)
  220. will result in incorrect information being displayed about its size, free and
  221. used.  Files over the same size will also result in display errors.  Such
  222. occurrences are highly unlikely in the near (used loosely) future.  Just
  223. thought I'd include such limitations in for your information.  Another
  224. limitation which will result in a crash is that each time a dir inside
  225. a dir is searched, 16 bytes (conservative figure) are used on the stack.
  226. So after going from a few hundred to a few thousand folders deep, stack
  227. space will run out.  I can't possibly imagine anyone having a few hundred
  228. folders deep..(deep meaning if u had a folder inside a folder inside the root
  229. dir, that's 3 levels deep).